twig.Environment.addExtension - Code Metrics - ForkNetwork/twig.js - Measure and Improve Code Quality continuously with Scrutinizer

twig.Environment.addExtension A
last analyzed 2016-11-28 10:32 UTC

↳ Parent: src-js/twig/environment.js

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	3
rs	10
cc	1
nc	1
nop	1

/*
 * Copyright 2011 Johannes M. Schmitt <[email protected]>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

goog.provide('twig.Environment');


goog.require('twig');
goog.require('twig.ExtensionInterface');
goog.require('twig.Template');
goog.require('twig.filter');

goog.require('goog.object');

/**
 * @constructor
 */
twig.Environment = function() {

    /**
     * @private
     * @type {Object.<twig.ExtensionInterface>}
     */
    this.extensions_ = {};

    /**
     * @private
     * @type {Object.<Function>}
     */
    this.filters_ = {};

    /**
     * @private
     * @type {Object.<Function>}
     */
    this.functions_ = {};

    /**
     * @private
     * @type {Object.<Function>}
     */
    this.tests_ = {};

    /**
     * @private
     * @type {Object.<twig.Template>}
     */
    this.createdTemplates_ = {};

    /**
     * @private
     * @type {Object}
     */
    this.globals_ = {};

    /**
     * @private
     * @type {boolean}
     */
    this.runtimeInitialized = false;

    /**
     * @private
     * @type {string}
     */
    this.charset_ = 'UTF-8';
};

/**
 * Returns the rendered template.
 *
 * @export
 * @param {Function} ctor The constructor of the template
 * @param {Object.<*>=} opt_context
 * @return {string}
 */
twig.Environment.prototype.render = function(ctor, opt_context) {

    var template = this.createTemplate(ctor);

    return template.render.call(template, twig.extend({}, this.globals_, opt_context || {}));

};

/**
 * Delegates to a filter function at runtime.
 *
 * @param {string} name
 * @param {*} arg1
 * @param {...*} var_args
 * @return {*}
 */
twig.Environment.prototype.filter = function(name, arg1, var_args) {

    if (!goog.object.containsKey(this.filters_, name)) {

        throw Error("The filter '" + name + "' does not exist.");
    }

    return this.filters_[name].apply(null, Array.prototype.slice.call(arguments, 1));
};

/**
 * Delegates to a function at runtime.
 *
 * @param {string} name
 * @param {*} arg1
 * @param {...*} var_args
 * @return {*}
 */
twig.Environment.prototype.invoke = function(name, arg1, var_args) {

    if (!goog.object.containsKey(this.functions_, name)) {

        throw Error("The function '" + name + "' does not exist.");
    }

    return this.functions_[name].apply(null, Array.prototype.slice.call(arguments, 1));
};

/**
 * Delegates to a test function at runtime.
 *
 * @param {string} name
 * @param {*} arg1
 * @param {...*} var_args
 * @return {boolean}
 */
twig.Environment.prototype.test = function(name, arg1, var_args) {

    if (!goog.object.containsKey(this.tests_, name)) {

        throw Error("The test '" + name + "' does not exist.");
    }

    return /** @type {boolean} */ (
        this.tests_[name].apply(null, Array.prototype.slice.call(arguments, 1)));
};

/**
 * Escapes the given value for the given context.
 *
 * @param {string} value
 * @param {twig.filter.escape.Type=} opt_type
 * @param {string=} opt_charset
 * @param {boolean=} opt_autoescape
 * @return {string}
 */
twig.Environment.prototype.escape = function(value, opt_type, opt_charset, opt_autoescape) {

    return twig.filter.escape(this, value, opt_type, opt_charset, opt_autoescape);

};

/**
 * Delegates to a macro at runtime.
 * 
 * @param {Function} templateCtor
 * @param {string} macroName
 * @param {...*} var_args
 * @return {string}
 */
twig.Environment.prototype.macro = function(templateCtor, macroName, var_args) {

	var template = this.createTemplate(templateCtor);
	var macro = template['get' + macroName];
	
	if (!macro) {
		throw Error("The macro '" + macroName + "' does not exist on template '" + template.getTemplateName() + "'.");
	}
	
	return macro.apply(template, Array.prototype.slice.call(arguments, 2)).toString();
};

/**
 * Sets a dynamic filter function at runtime.
 *
 * @export
 * @param {string} name
 * @param {Function} filter
 */
twig.Environment.prototype.setFilter = function(name, filter) {

    this.filters_[name] = filter;
};

/**
 * Sets a dynamic function at runtime
 *
 * @export
 * @param {string} name
 * @param {Function} func
 */
twig.Environment.prototype.setFunction = function(name, func) {

    this.functions_[name] = func;
};

/**
 * Sets a dynamic test function at runtime
 *
 * @export
 * @param {string} name
 * @param {Function} func
 */
twig.Environment.prototype.setTest = function(name, func) {

    this.tests_[name] = func;
};

/**
 * Sets the global variables.
 *
 * @export
 * @param {Object} globals
 */
twig.Environment.prototype.setGlobals = function(globals) {

    this.globals_ = globals;
};

/**
 * Sets a single global variable.
 *
 * @export
 * @param {string} key
 * @param {*} value
 */
twig.Environment.prototype.setGlobal = function(key, value) {

    this.globals_[key] = value;
};

/**
 * @return {Object}
 */
twig.Environment.prototype.getGlobals = function() {

    return this.globals_;
};

/**
 * @return {string}
 */
twig.Environment.prototype.getCharset = function() {

    return this.charset_;
};

/**
 * @param {string} charset
 */
twig.Environment.prototype.setCharset = function(charset) {

    this.charset_ = charset;
};

/**
 * Initializes the runtime environment.
 */
twig.Environment.prototype.initRuntime = function() {

    this.runtimeInitialized = true;

    goog.object.forEach(this.getExtensions(), function(extension) {

        extension.initRuntime(this);
    }, this);
};

/**
 * Returns true if the given extension is registered.
 *
 * @param {string} name The extension name
 *
 * @return {boolean} Whether the extension is registered or not
 */
twig.Environment.prototype.hasExtension = function(name) {

    return goog.object.containsKey(this.extensions_, name);

};

/**
 * Gets an extension by name.
 *
 * @param {string} name The extension name
 *
 * @return {twig.ExtensionInterface}
 */
twig.Environment.prototype.getExtension = function(name) {

    if (!goog.object.containsKey(this.extensions_, name)) {

        throw Error('The "' + name + '" extension is not enabled.');
    }

    return this.extensions_[name];
};

/**
 * Registers an extension.
 *
 * @param {twig.ExtensionInterface} extension
 */
twig.Environment.prototype.addExtension = function(extension) {

    this.extensions_[extension.getName()] = extension;
};

/**
 * Removes an extension by name.
 *
 * @param {string} name The extension name
 */
twig.Environment.prototype.removeExtension = function(name) {

    delete this.extensions_[name];
};

/**
 * Registers an array of extensions.
 *
 * @param {Array.<twig.ExtensionInterface>} extensions An array of extensions
 */
twig.Environment.prototype.setExtensions = function(extensions) {

    goog.object.forEach(extensions, function(extension) {

       this.addExtension(extension);
    });
};

/**
 * Returns all registered extensions.
 *
 * @return {Object.<string, twig.ExtensionInterface>} An array of extensions
 */
twig.Environment.prototype.getExtensions = function() {

    return this.extensions_;
};

/**
 * @param {Function} ctor
 * @return {twig.Template}
 */
twig.Environment.prototype.createTemplate = function(ctor) {

    var uid = goog.getUid(ctor);


    if (goog.object.containsKey(this.createdTemplates_, uid)) {
        return this.createdTemplates_[uid];
    }

    if (false === this.runtimeInitialized) {
        this.initRuntime();
    }

    var template = /** @type {twig.Template} */ (new ctor(this));


    this.createdTemplates_[uid] = template;

    return template;
};


1			/*
2			* Copyright 2011 Johannes M. Schmitt <[email protected]>
3			*
4			* Licensed under the Apache License, Version 2.0 (the "License");
5			* you may not use this file except in compliance with the License.
6			* You may obtain a copy of the License at
7			*
8			* http://www.apache.org/licenses/LICENSE-2.0
9			*
10			* Unless required by applicable law or agreed to in writing, software
11			* distributed under the License is distributed on an "AS IS" BASIS,
12			* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13			* See the License for the specific language governing permissions and
14			* limitations under the License.
15			*/
16
17			goog.provide('twig.Environment');
			0 ignored issues – show Bug introduced 2016-11-25 14:46 UTC by Report Bug Copy Issue Report The variable `goog` seems to be never declared. If this is a global, consider adding a `/** global: goog */` comment. This checks looks for references to variables that have not been declared. This is most likey a typographical error or a variable has been renamed. To learn more about declaring variables in Javascript, see the MDN. Loading history...
18
19			goog.require('twig');
20			goog.require('twig.ExtensionInterface');
21			goog.require('twig.Template');
22			goog.require('twig.filter');
23
24			goog.require('goog.object');
25
26			/**
27			* @constructor
28			*/
29			twig.Environment = function() {
			0 ignored issues – show Bug introduced 2016-11-25 14:46 UTC by Report Bug Copy Issue Report The variable `twig` seems to be never declared. If this is a global, consider adding a `/** global: twig */` comment. This checks looks for references to variables that have not been declared. This is most likey a typographical error or a variable has been renamed. To learn more about declaring variables in Javascript, see the MDN. Loading history...
30			/**
31			* @private
32			* @type {Object.<twig.ExtensionInterface>}
33			*/
34			this.extensions_ = {};
35
36			/**
37			* @private
38			* @type {Object.<Function>}

ForkNetwork / twig.js

GitHub Access Token became invalid

twig.Environment.addExtension A last analyzed 2016-11-28 10:32 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

twig.Environment.addExtension A
last analyzed 2016-11-28 10:32 UTC